Interface PolicyMapQosClass

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PolicyMapQosClassImpl

public interface PolicyMapQosClass extends IPCObject
Information provided by the PKI file:

    \class PolicyMapQosClass
    
    \brief PolicyMapQosClass handles and manipulates QoS classes.
    
    \example network().getDevice("Router0").getPolicyMapManager().getPolicyMapAt(0).getClassAt(0)
    
Author:
Auto-generated
  • Method Details

    • resetBandwidth

      void resetBandwidth()
      Information provided by the PKI file:
      
          \brief Resets the bandwidth.
          
              
    • setBandwidth

      void setBandwidth(int bandwidth)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth value.
          
          \param bandwidth, the bandwidth value.
          
              
      Parameters:
      bandwidth - Takes in a parameter of bandwidth
    • getBandwidth

      int getBandwidth()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth value.
          
          \return int, the bandwidth value.
          
              
      Returns:
      int Returns a int
    • setBandwidthPercent

      void setBandwidthPercent(int percent)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth percentage value.
          
          \param percent, the bandwidth percentage value.
          
              
      Parameters:
      percent - Takes in a parameter of percent
    • getBandwidthPercent

      int getBandwidthPercent()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth percentage value.
          
          \return int, the bandwidth percentage value.
          
              
      Returns:
      int Returns a int
    • setBandwidthRemainingPercent

      void setBandwidthRemainingPercent(int percent)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth remaining percentage value.
          
          \param percent, the bandwidth remaining percentage value.
          
              
      Parameters:
      percent - Takes in a parameter of percent
    • getBandwidthRemainingPercent

      int getBandwidthRemainingPercent()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth remaining percentage value.
          
          \return int, the bandwidth remaining percentage value.
          
              
      Returns:
      int Returns a int
    • isBandwidthConfigured

      boolean isBandwidthConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the bandwidth is configured, otherwise false.
          
          \return bool, true if the bandwidth is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • resetQueueLimit

      void resetQueueLimit()
      Information provided by the PKI file:
      
          \brief Resets the queue-limit.
          
              
    • getQueueLimit

      int getQueueLimit()
      Information provided by the PKI file:
      
          \brief Returns the queue-limit value.
          
          \return int, the queue-limit value.
          
              
      Returns:
      int Returns a int
    • setQueueLimit

      void setQueueLimit(int limit)
      Information provided by the PKI file:
      
          \brief Sets the queue-limit value.
          
          \param limit, the queue-limit value.
          
              
      Parameters:
      limit - Takes in a parameter of limit
    • getDefaultQueueLimit

      int getDefaultQueueLimit()
      Information provided by the PKI file:
      
          \brief Returns the default queue-limit value.
          
          \return int, the default queue-limit value.
          
              
      Returns:
      int Returns a int
    • resetPriority

      void resetPriority()
      Information provided by the PKI file:
      
          \brief Resets the priority.
          
              
    • setPriority

      void setPriority(int bandwidth, int burst)
      Information provided by the PKI file:
      
          \brief Sets the priority.
          
          \param bandwidth, the priority value.
          \param burst, the burst value.
          
              
      Parameters:
      bandwidth - Takes in a parameter of bandwidth
      burst - Takes in a parameter of burst
    • getPriority

      int getPriority()
      Information provided by the PKI file:
      
          \brief Returns the priority value.
          
          \return int, the priority value.
          
              
      Returns:
      int Returns a int
    • setPriorityPercent

      void setPriorityPercent(int percent, int burst)
      Information provided by the PKI file:
      
          \brief Sets the priority percentage.
          
          \param percent, the percentage value.
          \param burst, the burst value.
          
              
      Parameters:
      percent - Takes in a parameter of percent
      burst - Takes in a parameter of burst
    • getPriorityPercent

      int getPriorityPercent()
      Information provided by the PKI file:
      
          \brief Returns the priority percentage value.
          
          \return int, the priority percentage value.
          
              
      Returns:
      int Returns a int
    • getPriorityBurst

      int getPriorityBurst()
      Information provided by the PKI file:
      
          \brief Returns the priority burst value.
          
          \return int, the priority burst value.
          
              
      Returns:
      int Returns a int
    • getPriorityBurstDefault

      int getPriorityBurstDefault()
      Information provided by the PKI file:
      
          \brief Returns the default priority burst value.
          
          \return int, the default priority burst value.
          
              
      Returns:
      int Returns a int
    • isPriorityConfigured

      boolean isPriorityConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the priority is configured, otherwise false.
          
          \return bool, true if the priority is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • addSetDscpPrec

      void addSetDscpPrec(WredType wredType, boolean ipv4Only, int value)
      Information provided by the PKI file:
      
          \brief Adds DSCP or IP Precedence.
          
          \param wredType,    the QoS policy type.
          QoS policy types:   eWredDscp = 0,
          eWredPrec = 1
          \param ipv4Only, true for IPv4 only, false for both IPv4 and IPv6.
          \param value, the value for the QoS policy type.
          
              
      Parameters:
      wredType - Takes in a parameter of wredType
      ipv4Only - Takes in a parameter of ipv4Only
      value - Takes in a parameter of value
    • removeSetDscpPrec

      void removeSetDscpPrec()
      Information provided by the PKI file:
      
          \brief Removes DSCP or IP Precedence.
          
              
    • getSetDscpPrec

      PolicyClassSetDscp getSetDscpPrec()
      Information provided by the PKI file:
      
          \brief Returns the DSCP or IP precedence.
          
          \return PolicyClassSetDscp, the PolicyClassSetDscp object.
          
              
      Returns:
      PolicyClassSetDscp Returns a PolicyClassSetDscp
    • resetShapeAvgCir

      void resetShapeAvgCir()
      Information provided by the PKI file:
      
          \brief Resets the shaper average CIR.
          
              
    • setShapeAvgCir

      void setShapeAvgCir(int cir)
      Information provided by the PKI file:
      
          \brief Sets shaper average CIR value.
          
          \param cir, shaper average CIR value.
          
              
      Parameters:
      cir - Takes in a parameter of cir
    • isShapeConfigured

      boolean isShapeConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if traffic shaping is configured, otherwise false.
          
          \return bool, true if traffic shaping is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getFairQueueSize

      int getFairQueueSize()
      Information provided by the PKI file:
      
          \brief Returns the fair queue size value.
          
          \return int, the fair queue size value.
          
              
      Returns:
      int Returns a int
    • isFairQueueConfigured

      boolean isFairQueueConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if fair queueing is configured, otherwise false.
          
          \return bool, true if fair queueing is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getDefaultFairQueueSize

      int getDefaultFairQueueSize()
      Information provided by the PKI file:
      
          \brief Returns the default fair queue size.
          
          \return int, the default fair queue size.
          
              
      Returns:
      int Returns a int
    • isClassDefault

      boolean isClassDefault()
      Information provided by the PKI file:
      
          \brief Returns true if class default, otherwise false.
          
          \return bool, true if class default, otherwise false.
          
              
      Returns:
      boolean Returns a boolean